home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 5 / Gold Medal Software - Volume 5 (Gold Medal) (1995).iso / accounts / smrten21.arj / SMART10.TXT < prev    next >
Text File  |  1994-10-02  |  39KB  |  826 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                    Smart10  TM
  13.                            X10 Powerhouse Home Control
  14.                              CP290 Programming System
  15.  
  16.                                    version 2.1
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                                    Users Guide
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.                    ┌─────────┐
  32.              ┌─────┴───┐     │              (R)
  33.            ──│         │o    │──────────────────
  34.              │   ┌─────┴╨──┐ │  Association of
  35.              │   │         │─┘  Shareware
  36.              └───│    o    │    Professionals
  37.            ──────│    ║    │────────────────────
  38.                  └────╨────┘    MEMBER
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.      copyright 1991 Sympathetic Software
  47.  
  48.                           9531 Telhan Drive
  49.                           Huntington Beach, CA  92646
  50.                           USA
  51.  
  52.  
  53.  
  54.                                All Rights Reserved
  55.  
  56.  
  57.         September 6, 1994            Smart10 v2.1                      Page 1
  58.  
  59.                                   Table of Contents
  60.  
  61.         The Shareware Concept                                      2
  62.  
  63.         Support                                                    3
  64.  
  65.         Introduction                                               4
  66.  
  67.         Configuration                                              5
  68.  
  69.         Programming Your Events                                    7
  70.  
  71.         Command Line Parameters                                   11
  72.  
  73.         The CHKTIME Program                                       14
  74.  
  75.         The DSTIME Program                                        15
  76.  
  77.         Sample Files                                              15
  78.  
  79.         Change History                                            15
  80.  
  81.  
  82.         September 6, 1994            Smart10 v2.1                      Page 2
  83.  
  84.         The Shareware Concept
  85.  
  86.  
  87.              Shareware distribution gives users a chance to try software
  88.         before buying it.  If you try a Shareware program and continue using
  89.         it, you are expected to register.  Individual programs differ on
  90.         details - some request registration while others require it, some
  91.         specify a maximum trial period.  With registration, you get anything
  92.         from the simple right to continue using the software to an updated
  93.         program with printed manual.
  94.  
  95.              Copyright laws apply to both Shareware and commercial software,
  96.         and the copyright holder retains all rights, with a few specific
  97.         exceptions as stated below.  Shareware authors are accomplished
  98.         programmers, just like commercial authors, and the programs are of
  99.         comparable quality.  (In both cases, there are good programs and bad
  100.         ones!) The main difference is in the method of distribution.  The
  101.         author specifically grants the right to copy and distribute the
  102.         software, either to all and sundry or to a specific group.  For
  103.         example, some authors require written permission before a commercial
  104.         disk vendor may copy their Shareware.
  105.  
  106.              Shareware is a distribution method, not a type of software.  You
  107.         should find software that suits your needs and pocketbook, whether
  108.         it's commercial or Shareware.  The Shareware system makes fitting
  109.         your needs easier, because you can try before you buy.  And because
  110.         the overhead is low, prices are low also.  Shareware has the ultimate
  111.         money-back guarantee - if you don't use the product, you don't pay
  112.         for it.
  113.  
  114.              Smart10 is a "shareware program" and is provided at no charge to
  115.         the user for evaluation.  Feel free to share it with your friends,
  116.         but please do not give it away altered or as part of another system.
  117.         The essence of "user-supported" software is to provide personal
  118.         computer users with quality software without high prices, and yet to
  119.         provide incentive for programmers to continue to develop new
  120.         products.  If you find this program useful and find that you are
  121.         using Smart10 and continue to use Smart10 after a reasonable trial
  122.         period, you must make a registration payment of $20 to SYMPATHETIC
  123.         SOFTWARE.  The $20 registration fee will license one copy for use on
  124.         any one computer at any one time.  You must treat this software just
  125.         like a book.  An example is that this software may be used by any
  126.         number of people and may be freely moved from one computer location
  127.         to another, so long as there is no possibility of it being used at
  128.         one location while it's being used at another.  Just as a book cannot
  129.         be read by two different persons at the same time.
  130.  
  131.              Commercial users of Smart10 must register and pay for their
  132.         copies of Smart10 within 30 days of first use or their license is
  133.         withdrawn.  Site-License arrangements may be made by contacting
  134.         SYMPATHETIC SOFTWARE.
  135.  
  136.              Anyone distributing Smart10 for any kind of remuneration must
  137.         first contact SYMPATHETIC SOFTWARE.  This authorization will be
  138.         automatically granted to distributors recognized by the Association
  139.         of Shareware Professionals (ASP) as adhering to its guidelines for
  140.         shareware distributors, and such distributors may begin offering
  141.         Smart10 immediately (However SYMPATHETIC SOFTWARE must still be
  142.  
  143.  
  144.         September 6, 1994            Smart10 v2.1                      Page 3
  145.  
  146.         advised so that the distributor can be kept up-to-date with the
  147.         latest version of Smart10.).
  148.  
  149.              You are encouraged to pass a copy of Smart10 along to your
  150.         friends for evaluation.  Please encourage them to register their copy
  151.         if they find that they can use it.  All registered users will receive
  152.         a copy of the latest version of the Smart10 system including a
  153.         printed version of this manual.  To register your copy of Smart10,
  154.         send in a completed copy of the enclosed order form.
  155.  
  156.  
  157.         Support
  158.  
  159.  
  160.              The current version of Smart10 is available from the IBMHW forum
  161.         on CompuServ.  The file to download is SMRTEN.EXE.  Problem reports
  162.         may be made to Sympathetic Software or sent by CompuServ E-Mail to:
  163.  
  164.                   Stephen L Billard: 71046,1476
  165.  
  166.              This program is produced by a member of the Association of
  167.         Shareware Professionals (ASP).  ASP wants to make sure that the
  168.         shareware principle works for you.  If you are unable to resolve a
  169.         shareware-related problem with an ASP member by contacting the member
  170.         directly, ASP may be able to help.  The ASP Ombudsman can help you
  171.         resolve a dispute or problem with an ASP member, but does not provide
  172.         technical support for members' products.  Please write to the ASP
  173.         Ombudsman at 545 Grover Road, Muskegon, MI 49442-9427 or send a
  174.         CompuServ message via CompuServ Mail to ASP Ombudsman 70007,3536.
  175.         The Ombudsman may be contacted by FAX by sending to the ASP FAX
  176.         number: (616) 788-2765.  In communications with the Ombudsman please
  177.         include a telephone number and/or FAX if available.
  178.  
  179.  
  180.         September 6, 1994            Smart10 v2.1                      Page 4
  181.  
  182.         Introduction
  183.  
  184.  
  185.              Smart10 is intended for use with the X10 Powerhouse CP290
  186.         computer interface.  This interface can be programmed from a personal
  187.         computer and will maintain and execute up to 128 timer events.  These
  188.         events can be set for specific times and days of the week.  The
  189.         controller has a span of only one week, and does not have the concept
  190.         of sunrise and sunset.  The software which comes with the controller
  191.         is somewhat clumsy to use if you wish to define more than a few
  192.         events.
  193.  
  194.              Smart10 was devised to overcome the limitations of the CP290 and
  195.         its supplied software.  It can maintain a year's calendar of events.
  196.         You can use SUNRISE and SUNSET as times.  (You don't have use them as
  197.         exact time, you can add or subtract time from them.)  Events can be
  198.         conditioned to occur (or not to occur) if it is DARK (or LIGHT) or if
  199.         they occur between dates you have specified.  You can also put
  200.         parameters on the command line and use them as conditions.
  201.  
  202.              There is an "immediate" command mode (run from the command line)
  203.         whereby you can issue direct or delayed commands and cancel pending
  204.         events.  Two programs are included to help you automate your
  205.         AUTOEXEC.BAT files.  These are CHKTIME and DSTIME.  CHKTIME compares
  206.         the computer's date and time with target date and times.  ERRORLEVEL
  207.         is set if there is a match.  DSTIME is used to adjust your computer
  208.         clock for daylight savings time.  With Smart10 and these programs you
  209.         can completely automate maintainence of your CP290.  (You can
  210.         automate other periodic functions as well.  See the examples below.)
  211.  
  212.              Smart10 operates from a control file which describes the modules
  213.         you have and the timer events you've scheduled.  The format of this
  214.         file and its instructions is described below.  However, you don't
  215.         need to know anything of its format to begin using Smart10.  If you
  216.         are already using the CP290 you have the initial starting point for
  217.         your home automation.  The program GENPGM will create a control file
  218.         for you describing the modules and events you are currently using.
  219.         Just modify this file to add the additional capabilities that Smart10
  220.         provides.
  221.  
  222.  
  223.         September 6, 1994            Smart10 v2.1                      Page 5
  224.  
  225.         Configuring Smart10
  226.  
  227.  
  228.              When Smart10 is first run, or when you use /C on the command
  229.         line, you will be presented with the Smart10 Registration screen and
  230.         the Smart10 configuration screen.  These screens are shown below.
  231.  
  232.              ┌───────────────────────────────────────────────────────────┐
  233.              │ Smart10 X10 Powerhouse Control Program                    │
  234.              │ Copyright 1991 by Sympathetic Software                    │
  235.              │                                                           │
  236.              │                    Registration Information               │
  237.              │                                                           │
  238.              │      Your Name:                                           │
  239.              │                                                           │
  240.              │      Registration ID:                                     │
  241.              │                                                           │
  242.              └───────────────────────────────────────────────────────────┘
  243.  
  244.         For now, type ESC to bypass the registration screen.  When you send
  245.         in your registration, you will get instructions on filling in this
  246.         screen.  (Note: if you do not type anything for 30 seconds, the
  247.         registration screen automatically goes away.  Once you have
  248.         registered Smart10, the screen will not be redisplayed.)
  249.  
  250.              ┌───────────────────────────────────────────────────────────┐
  251.              │ Smart10 X10 Powerhouse Control Program                    │
  252.              │ Copyright 1991 by Sympathetic Software                    │
  253.              │                                                           │
  254.              │                    Configuration Information              │
  255.              │                                                           │
  256.              │      House Code: A                                        │
  257.              │                                                           │
  258.              │      Latitude: 33° 48' 0" N                               │
  259.              │                                                           │
  260.              │      Longitude: 117° 54' 0" W                             │
  261.              │                                                           │
  262.              │      Time Zone: PACIFIC                                   │
  263.              │                                                           │
  264.              │      Do you observe Daylight Savings time? (Y/N) Y        │
  265.              │                                                           │
  266.              │      Confirm time override? (Y/N) N                       │
  267.              │                                                           │
  268.              │      Synchronize CP290 to the minute? (Y/N) N             │
  269.              │                                                           │
  270.              │      The CP290 is attached to: COM1                       │
  271.              │                                                           │
  272.              └───────────────────────────────────────────────────────────┘
  273.  
  274.  
  275.              You should set House Code to the House Code you wish the CP290
  276.         to use when one of its eight rocker switches is activated.  Set the
  277.         Latitude and Longitude to your location.  You do not need to be very
  278.         precise with these.  They are used in computing Sunrise and Sunset
  279.         times.  The location of any nearby major city will probably be close
  280.         enough.  (The file LOCATION.TXT contains a list of cities and their
  281.         latitudes and longitudes.)  Time Zone should be set to your time
  282.         zone.  Smart10 will offer a default based on your longitude.  You
  283.  
  284.  
  285.         September 6, 1994            Smart10 v2.1                      Page 6
  286.  
  287.         will have to correct this if you live near an irregularity of the
  288.         time zone line.  If you live in an area which does not observe
  289.         Daylight Savings time then you should answer N (for No) to the
  290.         Daylight Savings time question.  Otherwise answer Y (for Yes).
  291.  
  292.              If you set Confirm time override to Y, Smart10 will ask you for
  293.         confirmation if the computer's time differs from the time kept by the
  294.         CP290 by more than about five minutes.  As long as you trust your
  295.         computer's clock you should configure this as N.  The CP290's clock
  296.         will then be set to the computer's time.  This is specially important
  297.         if you are going to automatically load the CP290 in the middle of the
  298.         night.
  299.  
  300.              The CP290's time setting accuracy is only within a minute.  In
  301.         other words, it cannot be set to a particular second.  Thus, unless
  302.         the computer waits until its clock is an even minute before setting
  303.         the CP290, its time may be off by many seconds.  The Synchronize
  304.         CP290 to the minute option causes Smart10 to wait until the computer
  305.         clock is at an even minute before setting the CP290 clock.  The
  306.         downside of this option is the extra time it takes to wait for an
  307.         even minute.
  308.  
  309.              You may select any serial port to attach your CP290.  Enter COM1
  310.         for the first serial port, COM2 for the second.  If you have a non
  311.         standard IO base address for your serial port, you may the address
  312.         instead of COM1 or COM1.  The address must be entered in hexidecimal
  313.         (e.g.. 3F8 for COM1.)
  314.  
  315.              The configuration is stored permanently in the SMART10.INI file.
  316.         This file will be located in the directory which contains the Smart10
  317.         program.  Although this file is stored in a display format, you
  318.         should not attempt to modify its contents.  Use the reconfiguration
  319.         feature of Smart10 to change its configuration.
  320.  
  321.  
  322.         September 6, 1994            Smart10 v2.1                      Page 7
  323.  
  324.         Programming Your Events
  325.  
  326.  
  327.              You describe your timer events to Smart10 by providing it a
  328.         module/event file.  This file is normally called X10.PGM.  (It is
  329.         possible to use any file name.  X10.PGM is the default.)  This file
  330.         contains a series of Module Identifications and associated Module
  331.         Events.
  332.  
  333.              The GENPGM program is included to make it easier for you to get
  334.         started using Smart10.  If you already have modules and events stored
  335.         in your CP290 then creating a module/event file for Smart10 is just a
  336.         matter of running GENPGM.  GENPGM needs to read the X10.DAT file that
  337.         the software which comes with your CP290 creates.  This file must be
  338.         in the currently logged on directory when you run GENPGM.  (That is,
  339.         you must CD to the directory which has this file.  Most likely this
  340.         is the \X10 directory.)  If the X10.DAT file is not available, GENPGM
  341.         will not have the module names for your modules.  It will make up
  342.         names for them.
  343.  
  344.              When you run GENPGM it will ask for the COM port where your
  345.         CP290 is attached.  Enter the appropriate COM port or the hex IO
  346.         address if your port does not use the standard addresses.  GENPGM
  347.         will write GENX10.PGM.  This file will be a module/event file which
  348.         reproduces the modules and events you are currently running.  Use
  349.         this file as a starting point.  Edit with any ASCII text editor and
  350.         turn it into a description of how you want to run your house.  (You
  351.         should rename the edited file X10.PGM so that Smart10 will use it as
  352.         the default program.)
  353.  
  354.              The Smart10 module/events program file consists of a series of
  355.         Module Identification headings and the module's associated events.
  356.         Module Identifications and Module Events must be wholly contained on
  357.         one line.  You may include commentary (which may be multiple lines)
  358.         by enclosing it within braces ("{" and "}").
  359.  
  360.              A Module Identification identifies the X10 unit you wish to
  361.         control.  A Module Identification consists of a Location and
  362.         Description separated by a colon (":") followed
  363.  
  364.  
  365.         September 6, 1994            Smart10 v2.1                      Page 8
  366.  
  367.         by a crosshatch ("#") or asterisk ('*') and the House Code and Unit
  368.         number of the module.  Example:
  369.  
  370.                 Master bedroom : Light switch #A5
  371.  
  372.                 Study : Computer *B1
  373.  
  374.         The text you provide for the Location and Description are written to
  375.         the X10.DAT file used by the software which comes with the CP290.
  376.         They are also optionally displayed by Smart10 when it is loading the
  377.         CP290.  They can be any text (exclusive of a colon, crosshatch, or
  378.         asterisk.)  The house and unit codes should match the setting on the
  379.         X10 module.
  380.  
  381.              Crosshatch is the normal prefix for the House Code and Unit
  382.         number.  Asterisk is used when you do not want the power fail restore
  383.         function to set the module to its current programmed state.  (For
  384.         instance, if the latest event for the Study Computer was off, you
  385.         would not want the power fail restore function to turn if off as the
  386.         restore was executing.)
  387.  
  388.              It is possible to have a Module Identification refer to more
  389.         than one unit within a House Code.  In this case, the module events
  390.         will effect all the units identified by the Module Identification.
  391.         To specify multiple unit codes, Concatenate the additional unit codes
  392.         with either an ampersand (&) or an ellipsis (..).  Example:
  393.  
  394.                 Emergency Lights: Living Areas *A1&4
  395.  
  396.                 All Lights: Whole House *B1..16
  397.  
  398.                 Some Lights: Living Room *C3..5&8
  399.  
  400.         Ampersands are used to indicate single units.  Ellipses are used to
  401.         indicate a series of units.  For the first example, module events
  402.         will turn on and off modules A1 and A4.  Module events for the second
  403.         example will effect modules B1, B2, B3, B4, B5, B7, B8, B9, B10, B11,
  404.         B12, B13, B14, B15 and B16.  The third example controls modules C3,
  405.         C4, C5 and C8.
  406.  
  407.              The software which comes with the CP290 does not support
  408.         multiple unit Module Identifications.  Thus, if you use the X10
  409.         program to review your events you will not see any these modules and
  410.         events.  Also note that these Module Identifications do not appear in
  411.         the Module Map.
  412.  
  413.              A Module Event consists of a command, time, optional condition,
  414.         and the days the event should be activated.  The Module Event
  415.         commands are ON, OFF, DIM, FADE and BRIGHT.  (These may be proceeded
  416.         with CANCEL if you are deactivating an event.)  BRIGHT and FADE are
  417.         undocumented commands of the CP290.  There is no guarentee that your
  418.         CP290 will excute these commands in a useable manner.  FADE will dim
  419.         a light to the off setting.  BRIGHT works like DIM, but brightens the
  420.         light from a dimmed setting.  Times may be absolute or security mode,
  421.         and can be expressed in military time or civilian time.  You may also
  422.         use SUNSET, SUNRISE, or NOW as a time.  These latter may be modified
  423.         by adding or subtracting a time value.  CANCEL and NOW are most
  424.         useful in command line event setting.  See below.
  425.  
  426.  
  427.         September 6, 1994            Smart10 v2.1                      Page 9
  428.  
  429.              There may be any number of Module Events following a Module
  430.         Identification.  The only constraint it that the CP290 can manage
  431.         only 128 events.  Examples of Module Events:
  432.  
  433.                 ON @ 2300 EVERYDAY
  434.  
  435.                 OFF ~ 10:00pm SATURDAY
  436.  
  437.                 DIM 70% @ SUNSET + 0:10 WEEKDAYS
  438.  
  439.         The At sign ("@") is used when the time is absolute.  The tilde ("~")
  440.         is used to specify approximate (security mode) time.  For security
  441.         mode time, the event is set randomly to within 15 minutes of the time
  442.         value given.  The CP290 will randomly vary this time each day as
  443.         well.
  444.  
  445.              The days the event is to be activated is either TODAY, TOMORROW,
  446.         EVERYDAY, DAILY, or a list of the actual days.  You can use WEEKENDS
  447.         in place of SATURDAY SUNDAY and you can use WEEKDAYS in place of
  448.         MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY.  These names can be
  449.         abbreviated.  Examples of activation days:
  450.  
  451.                 ON @ 0400 SUN MON
  452.  
  453.                 OFF @ 11:45pm DAILY
  454.  
  455.                 DIM 30 % @ SUNRISE - 2:00 FRI WEEKENDS
  456.  
  457.                 OFF NOW+0:20 TODAY
  458.  
  459.         TODAY and TOMORROW have special meaning to the CP290.  These events
  460.         occur only once.  The CP290 clears them once the day has past.
  461.  
  462.              You can use a specific date in place of an activation day list.
  463.         An example of this is:
  464.  
  465.                 ON @ 1700 ON 7/4
  466.  
  467.              There are modifiers which can be used to control when an event
  468.         will be active.  It may be active only between certain dates,
  469.         starting on a date or running until a date.  Alternatively, the event
  470.         may be active only when a condition is met.  An example of the former
  471.         is:
  472.  
  473.                 ON @ SUNSET + 0:30 DAILY BETWEEN 11/15 AND 12/1
  474.  
  475.                 ON @ SUNSET + 0:30 DAILY STARTING 11/15/95
  476.  
  477.                 ON @ SUNSET + 0:30 DAILY UNTIL 12/1/94
  478.  
  479.         A condition may be DARK, LIGHT, EARLIERTHAN a time, LATERTHAN a time,
  480.         or it may be a character string.  When the condition is a character
  481.         string, it is true if the character string is a parameter on the
  482.         command line when Smart10 is run.  Otherwise it is false.  (The
  483.         character strings may not contain blanks or other special
  484.         characters.)
  485.  
  486.  
  487.         September 6, 1994            Smart10 v2.1                     Page 10
  488.  
  489.         The condition may also be an expression involving NOT, AND, OR, and
  490.         parenthesis.  Some examples are:
  491.  
  492.                 OFF ~ 11:00pm IF DARK AND NOT (OUT OR VISITORS) SAT
  493.  
  494.                 ON @ Sunset IF EARLIERTHAN 7:00 PM EVERYDAY
  495.  
  496.         You may use ampersand ("&") for AND and bar ("|") for OR.  A Module
  497.         Event may have both a condition and a date modifier.  Example:
  498.  
  499.                 ON @ 2100 IF OUT | NOT VISITORS SAT BETWEEN 1/12 AND 3/3
  500.  
  501.              You can also use EXCEPT with ON and BETWEEN.  This causes the
  502.         event be activated on all but the indicated date(s).  Examples are:
  503.  
  504.                 ON @ 1700 EXCEPT ON 7/4
  505.  
  506.                 ON @ SUNSET + 0:30 DAILY EXCEPT BETWEEN 11/15 AND 12/1
  507.  
  508.              The X10 software which came with your CP290 has an anomaly with
  509.         its DIM function.  The X10 system allows for 16 levels of DIM from
  510.         fully bright to fully dim.  The X10 software allows only nine levels
  511.         (from 90% to 10%.)  It assigns (rather arbitrarily) dim levels to
  512.         these nine steps.  Any intermediate value the X10 software finds is
  513.         reported as 90% dim no matter what its real value is.  If you use the
  514.         X10 software to review dim values set by Smart10 you will not get
  515.         correct reporting.
  516.  
  517.              The CP290 can not deal with anything more complex than day of
  518.         the week.  For the above events to work, you must run Smart10 at
  519.         least once a week.  This allows the program to load the events for
  520.         the week.  You must also re-run Smart10 if one of the character
  521.         string conditions needs to be changed.  The program can optionally
  522.         display the events which are active for the week as it loads the
  523.         CP290 to show you what has been selected.
  524.  
  525.              Automatically loading the CP290 once a week is a simple task if
  526.         you use an X10 module to turn on and off your computer.  You can set
  527.         an event to turn on the computer once a week and use the CHKTIME
  528.         program in your AUTOEXEC.BAT file to run Smart10 when the computer is
  529.         automatically powered on.  For instance, for your computer have a
  530.         Module Event as follows:
  531.  
  532.                 Office:Computer #A1
  533.                     ON @ 3am SUNDAY
  534.  
  535.         And in your AUTOEXEC.BAT file have:
  536.  
  537.                 CHKTIME SUN 0300
  538.                 IF ERRORLEVEL 1 GOTO SETEVENTS
  539.                 .
  540.                 .
  541.                 .
  542.                 :SETEVENTS
  543.                 Smart10
  544.                 Smart10 /S A1 OFF
  545.  
  546.  
  547.         September 6, 1994            Smart10 v2.1                     Page 11
  548.  
  549.         This would turn the computer on at 3am each Sunday.  The batch file
  550.         would check to see if it was 3am, and if so would execute Smart10 to
  551.         load the X10.PRG file into the CP290.  Then it uses Smart10 to send
  552.         an immediate command to turn the computer off.
  553.  
  554.  
  555.         Command Line Parameters to Smart10
  556.  
  557.  
  558.         Loading a file other than X10.PGM:
  559.  
  560.              Run Smart10 with the command line parameter /F:filename.
  561.         Smart10 will read filename to get the Module Descriptions and Module
  562.         Events to load into the CP290. The CP290 is cleared before the events
  563.         are loaded.  Example:
  564.  
  565.                 Smart10 /F:vacation.sch
  566.  
  567.         Testing a schedule without loading the CP290
  568.  
  569.              Run Smart10 with the command line parameter /T if you wish to
  570.         check the validity of your schedule program without actually loading
  571.         the CP290.  This option causes Smart10 to go through all its
  572.         processing with the exception that it will not send any commands to
  573.         the CP290.  Example:
  574.  
  575.                 Smart10 /T
  576.  
  577.         Adding events to a CP290 program
  578.  
  579.              Run Smart10 with the command line parameter /A:filename.
  580.         Smart10 will read filename to get the Module Descriptions and Module
  581.         Events to be added to the events loaded in the CP290.  The difference
  582.         between loading events with the /A parameter and loading from the
  583.         default file or from a file named via the /F parameter is that the
  584.         CP290 is not cleared first.  This means that the events described in
  585.         filename are added to the events already loaded in the CP290.
  586.         Example:
  587.  
  588.                 Smart10 /A:oneshot
  589.  
  590.         The file loaded might contain a lawn sprinkler program with events
  591.         defined for TODAY.  You would run Smart10 to add these events to the
  592.         CP290 when the lawn needs watering.  Since the events are defined for
  593.         TODAY, the CP290 will clear them out once they are done.
  594.  
  595.         Reconfiguring Smart10:
  596.  
  597.              Run Smart10 with the command line parameter /C.  This will cause
  598.         Smart10 to present you with the configuration screen.  (See page 5
  599.         for configuring Smart10.)  Example:
  600.  
  601.                 Smart10 /C
  602.  
  603.         Resetting all modules after a power failure:
  604.  
  605.              Run Smart10 with the command line parameter /R.  Smart10 will
  606.         load the CP290 from your Description-Event file and set each module
  607.  
  608.  
  609.         September 6, 1994            Smart10 v2.1                     Page 12
  610.  
  611.         to the state it would be if the power had not failed.  Modules which
  612.         use asterisk in place of crosshatch for the house code-unit number
  613.         prefix are omitted from this power fail restore.  Example:
  614.  
  615.                 Smart10 /R
  616.  
  617.         Display the event commands being loaded to the CP290
  618.  
  619.              Run Smart10 with the command line parameter /E and it will
  620.         display each event as it is loaded into the CP290.  (An events which
  621.         is not active either because its condition is false or because the
  622.         current date is out of range with its date range will not be shown.)
  623.  
  624.                 Smart10 /E
  625.  
  626.         will display the active events.  You can direct the output of this
  627.         option to a file or the printer by adding a colon and the file name
  628.         to the parameter.
  629.  
  630.                 Smart10 /E:EVENTS.LOG
  631.  
  632.         will write the active events to the file EVENTS.LOG.
  633.  
  634.                 Smart10 /E:LPT1
  635.  
  636.         will write the active events to the printer.
  637.  
  638.         Print out a module map:
  639.  
  640.              Run Smart10 with the command line parameter of Smart10 /M to
  641.         display a map of the X10 modules you have defined in your
  642.         module/event program.
  643.  
  644.                 Smart10 /M
  645.  
  646.         will display the module map.  As with Events, you can direct the
  647.         output of this option to a file or the printer by adding a colon and
  648.         the file name to the parameter.
  649.  
  650.                 Smart10 /M:LPT1
  651.  
  652.         will print a list of module locations and descriptions and their
  653.         module house and unit codes.
  654.  
  655.  
  656.         September 6, 1994            Smart10 v2.1                     Page 13
  657.  
  658.         Send a module control command from your computer:
  659.  
  660.              Run Smart10 with the command line parameter /S Module-ID
  661.         Module-Event.  Module-ID is any House Code Unit Code pair.
  662.         Module-Event is as described for the Description-Event file.  In
  663.         addition, you may use a simple ON, OFF, or DIM command with no time,
  664.         etc.  This is equivalent of a time of NOW.  You may omit the day list
  665.         as well.  Then the event is set for Today or Tomorrow depending on
  666.         the time value.  (If you select a time greater then midnight and less
  667.         then NOW, then the event is set for Tomorrow.  You might do this by
  668.         using NOW + 23:00 or NOW -1:00.)  These events are one time
  669.         occurrences.  The CP290 will discard the event once the day has past.
  670.         If you use the /S parameter, the rest of the command line is assumed
  671.         to be the Module ID and Module Event.  Examples:
  672.  
  673.                 Smart10 /S A1 OFF
  674.                 Smart10 /S A2 CANCEL OFF @ 3:15am SUN
  675.                 Smart10 /S A3 OFF NOW + 0:10
  676.  
  677.         Events which are scheduled to occur within a minute of the current
  678.         time are issued as direct commands by Smart10.  Others are loaded as
  679.         one time events for Today or Tomorrow.
  680.  
  681.              I use OFF NOW + 0:05 to turn off my computer when it has
  682.         finished doing my backups.  The extra five minutes gives the tape
  683.         drive a chance to rewind.
  684.  
  685.         Setting conditions from the command line:
  686.  
  687.              Any character string not started with a slash ("/") and not
  688.         including a blank is noted as a condition by Smart10.  Conditions can
  689.         be tested in Module Events.  A condition is TRUE if it appears on the
  690.         Smart10 command line.
  691.  
  692.  
  693.         September 6, 1994            Smart10 v2.1                     Page 14
  694.  
  695.         Otherwise it is FALSE.  Examples of command line conditions:
  696.  
  697.                 Smart10 SomeoneIsOut GuestsAreStaying
  698.                 Smart10 MichaelIsHome
  699.  
  700.         The case of the condition is ignored.  MichaelIsOut is the same as
  701.         MICHAELISOUT.
  702.  
  703.              You may have combinations of the above parameters on the command
  704.         line.  Of course, if you use /S, it must be the last command line
  705.         function.  Example:
  706.  
  707.                 Smart10 MichaelIsHome /R /E
  708.  
  709.         If you have a /S command, Smart10 will not read and process the
  710.         Description-Event file.
  711.  
  712.  
  713.         CHKTIME
  714.  
  715.  
  716.              CHKTIME compares the computer date and time with command line
  717.         target date-times.  If the computer date-time is within plus or minus
  718.         15 minutes of a target time, the DOS ERRORLEVEL value is set to
  719.         indicate the match.  If no targets match, ERRORLEVEL is set to 0.
  720.         The targets are compared from left to right as they appear on the
  721.         command line.  If the first target matches, ERRORLEVEL is set to 1.
  722.         If the second matches, ERRORLEVEL is set to 2, etc.  If multiple
  723.         targets match, ERRORLEVEL is set to the value for the first target
  724.         which matches.
  725.  
  726.              The sensitivity value (15 minutes) may be changed by adding a
  727.         slash ("/") parameter to the command line.  The parameter /0:20
  728.         changes the sensitivity value to 20 minutes.  You may set more than
  729.         one sensitivity value.  The value applies to all target times to its
  730.         right on the command line.
  731.  
  732.              Target times can be one of: a simple time-3:00AM; a day of the
  733.         week and time-SAT 1230; a month  day of the week  time-AUGUST 23
  734.         6:15PM; an ordinal number (optionally with a month)  time-2ND 0800,
  735.         1ST NOVEMBER 4:45AM; an ordinal number  day of the week (and
  736.         optionally IN month)  time-2ND SUNDAY 1900, 3rd SUNDAY IN JANUARY
  737.         5:45pm.  LAST may be used as an ordinal number to signify the last
  738.         day in the month.  If months are left out, then the current month is
  739.         assumed.  Examples
  740.  
  741.                 CHKTIME SUN 0300, 1ST SUN IN APR 0300, LAST SUN IN OCT 0300
  742.                 CHKTIME 1ST 3AM, SEPTEMBER 11 5PM
  743.  
  744.         The first example looks for 3am on Sundays.  If it happens on the
  745.         first Sunday in April (daylight savings time starts) then ERRORLEVEL
  746.         is set to 2.  If it happened on the last Sunday in October (daylight
  747.         savings time ends) then ERRORLEVEL is set to 3.  On any other Sunday
  748.         at 3am ERRORLEVEL will be set to 1.  You can use this example to
  749.         automate changing your computer clock for daylight savings time and
  750.         then setting events in the CP290.  Your AUTOEXEC.BAT file would look
  751.         like the following:
  752.  
  753.  
  754.         September 6, 1994            Smart10 v2.1                     Page 15
  755.  
  756.                 CHKTIME SUN 0300, 1ST SUN IN APRIL 0300, LAST SUN IN OCT 0300
  757.                 IF ERRORLEVEL 3 GOTO DSTOFF
  758.                 IF ERRORLEVEL 2 GOTO DSTON
  759.                 IF ERRORLEVEL 1 GOTO SETEVENTS
  760.                 GOTO NOTTIME
  761.                 :DSTOFF
  762.                 rem "Fall back" on the last Sunday in October
  763.                 DSTIME OFF
  764.                 GOTO SETEVENTS
  765.                 :DSTON
  766.                 rem "Spring forward" on the 1st Sunday in April
  767.                 DSTIME ON
  768.                 :SETEVENTS
  769.                 Smart10
  770.                 Smart10 /s A1 off
  771.                 :NOTTIME
  772.  
  773.         The DSTIME program
  774.  
  775.  
  776.              The DSTIME program is used to add or subtract an hour from your
  777.         computer's clock.  You can use it to automate changing the clock when
  778.         Daylight Savings time
  779.  
  780.              changes.  DSTIME ON sets the clock forward one hour and DSTIME
  781.         OFF sets it back one hour.
  782.  
  783.  
  784.         Example files
  785.  
  786.  
  787.              An example autoexec batch file and Smart10 module/event program
  788.         file have been included with this distribution.  These files
  789.         illustrate the topics described in this document.
  790.  
  791.  
  792.         Change History:
  793.  
  794.  
  795.         1.0  Original Release
  796.         1.1  Corrected CHKTIME problem with "LAST"
  797.              Corrected SMART10 problem with cancel
  798.              Corrected GENPGM problem with DIM values
  799.              Corrected handling of IF expressions using "|', "&" and Parens
  800.         1.2  Added EARLIERTHAN and LATERTHAN conditions
  801.         1.3  Added multiple unit Module Identifications
  802.              Fixed error in registration code
  803.         1.4  Added the INI file for configuration parameters
  804.              Fixed handling of BETWEEN which wraps year end
  805.         1.5  Cleaned up syntax checking on Module line
  806.              Enhanced GENPGM to handle multi-events, Unknown modules
  807.              Added verbiage on what Smart10 is doing
  808.         1.6  Reclaimed dead event slots
  809.         1.7  Fixed random failure of Daylight Savings Time
  810.         1.8  Added file output option for Map and Event displays
  811.              Added Clock synchronization to the second
  812.              Corrected syntax parsing on missing day specification
  813.              Fixed problems with Restore and multi-events
  814.  
  815.  
  816.         September 6, 1994            Smart10 v2.1                     Page 16
  817.  
  818.         1.9  Fixed problems with NOW on immediate commands
  819.         2.0  Fixed problem with "OK to override time"
  820.         2.1  Fixed powerfail not taking into account previous day state
  821.              Enabled Sunrise, Sunset and Now in EARLIERTHAN, etc.
  822.              Configure now guesses at a timezone based on longitude.
  823.              Added undocumented commands BRIGHT and FADE
  824.              Added full date handling (Years now allowed)
  825.              Added NOT to ON and BETWEEN syntax
  826.              Added STARTING and UNTIL to date handling